home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / labelclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  6.4 KB  |  301 lines
  1. TABLE OF CONTENTS
  2.  
  3. labelclass/--background--
  4. labelclass/IM_EXTENT
  5. labelclass/LAB_Flags
  6. labelclass/LAB_Highlight
  7. labelclass/LAB_HighUScore
  8. labelclass/LAB_Label
  9. labelclass/LAB_LabelID
  10. labelclass/LAB_Place
  11. labelclass/LAB_Style
  12. labelclass/LAB_Template
  13. labelclass/LAB_TextAttr
  14. labelclass/LAB_Underscore
  15. labelclass/LAB_[#?]Pen
  16.  
  17. labelclass/--background--
  18.  
  19.     NAME
  20.     Class:        labelclass
  21.     Superclass:    BGUI_IMAGE_OBJECT
  22.     Include File:    <bgui/bgui_image.h>
  23.  
  24.     FUNCTION
  25.     To  provide  a    general  labeling  image. It supports underscoring and
  26.     placement  of  the label similar to the gadtools gadget labels. It can
  27.     do multi-line labels.
  28.  
  29. labelclass/IM_EXTENT
  30.  
  31.     NAME
  32.     IM_EXTENT -- Get label/hitbox extentions.
  33.  
  34.     SYNOPSIS
  35.     DoMethod( obj, IM_EXTENT, rp, extent, width, height, flags )
  36.  
  37.     struct RastPort         *rp;
  38.     struct IBox        *extent;
  39.     UWORD            *width;
  40.     UWORD            *height;
  41.     UWORD             flags;
  42.  
  43.     FUNCTION
  44.     This  method will ask a labelclass object for the amount of pixels the
  45.     label extends the image bounding box.    Normally  this    method is only
  46.     used by the baseclass which handles labels but in some cases you might
  47.     need this method for yourself.
  48.  
  49.     INPUTS
  50.     rp    - This    must  point  to  the RastPort in which the label is to
  51.         be rendered.  It  is copied to an internal buffer  and on that
  52.         copy  font  changes  and  calculations    will  be  made    so the
  53.         RastPort you pass here remains unchanged. This must be valid.
  54.  
  55.     extent    - This     field     is   used  to    store  the  label  extentions.
  56.         The label extentions are simply the  number  of  pixels  which
  57.         the label extends the image bounding box  in either direction.
  58.         The Left and Top fields will always be    smaller  than or equal
  59.         to zero. The Width and Height  fields  will always be equal to
  60.         or bigger than zero. This must be valid.
  61.  
  62.     width,
  63.     height    - In  these  pointers  the total pixel width and height of the
  64.         label are stored. This must be valid.
  65.  
  66.     flags    - This value field may contain any of the following flags:
  67.  
  68.         EXTF_MAXIMUM -- Normally   when  this  method  is  called  the
  69.             returned values are the extentions as they  are at the
  70.             moment you call this method.   When this flag  is  set
  71.             the   returned     values   are    the  maximum  possible
  72.             extentions  the  label    can have.
  73.  
  74.         Please note that this value is only 16 bits.
  75.  
  76.     RESULT
  77.     No return code defined.
  78.  
  79. labelclass/LAB_Flags
  80.  
  81.     NAME
  82.     LAB_Flags -- ( ULONG )
  83.  
  84.     FUNCTION
  85.     Set or get  the flag settings of the label.   The  following flags are
  86.     possible:
  87.  
  88.     LABF_HIGHLIGHT --  Normally  the  label  is  rendered  in  the TEXTPEN
  89.         or FILLTEXTPEN color.  When this  flag    is  set  the  label is
  90.         rendered in the HIGHLIGHTTEXTPEN color.
  91.  
  92.     LABF_HIGH_USCORE -- This is the  same  as  LABF_HIGHLIGHT only now the
  93.         color of the underscoring is affected.
  94.  
  95.     DEFAULT
  96.     0.
  97.  
  98.     APPLICABILITY
  99.     (ISG).
  100.  
  101.     SEE ALSO
  102.     LAB_Highlight, LAB_HighUScore, <intuition/screens.h>
  103.  
  104. labelclass/LAB_Highlight
  105.  
  106.     NAME
  107.     LAB_Highlight -- ( BOOL )
  108.  
  109.     FUNCTION
  110.     Set or clear the LABF_HIGHLIGHT flag.
  111.  
  112.     DEFAULT
  113.     FALSE.
  114.  
  115.     APPLICABILITY
  116.     (ISG).
  117.  
  118.     SEE ALSO
  119.     LAB_Flags
  120.  
  121. labelclass/LAB_HighUScore
  122.  
  123.     NAME
  124.     LAB_HighUScore -- ( BOOL )
  125.  
  126.     FUNCTION
  127.     Set or clear the LABF_HIGH_USCORE flags.
  128.  
  129.     DEFAULT
  130.     FALSE.
  131.  
  132.     APPLICABILITY
  133.     (ISG).
  134.  
  135.     SEE ALSO
  136.     LAB_Flags
  137.  
  138. labelclass/LAB_Label
  139.  
  140.     NAME
  141.     LAB_Label -- ( STRPTR )
  142.  
  143.     FUNCTION
  144.     Set or get the actual text for the label.  This may contain standard
  145.     infoclass command sequences, and be multiple lines.
  146.  
  147.     DEFAULT
  148.     NULL.
  149.  
  150.     APPLICABILITY
  151.     (ISG).
  152.  
  153.     SEE ALSO
  154.     LAB_LabelID, infoclass.doc/INFO_TextFormat
  155.  
  156. labelclass/LAB_LabelID
  157.  
  158.     NAME
  159.     LAB_LabelID -- ( ULONG ) ** V41 **
  160.  
  161.     FUNCTION
  162.     Set or get the ID for LAB_Label.  BASE_LOCALIZE uses this to set LAB_Label.
  163.  
  164.     DEFAULT
  165.     0.
  166.  
  167.     APPLICABILITY
  168.     (ISG).
  169.  
  170.     SEE ALSO
  171.     LAB_Label, baseclass.doc/BASE_LOCALIZE
  172.  
  173. labelclass/LAB_Place
  174.  
  175.     NAME
  176.     LAB_Place -- ( ULONG )
  177.  
  178.     FUNCTION
  179.     Set or get the place relative to the  image  bounding box at which the
  180.     label is rendered. The following places are possible:
  181.  
  182.     PLACE_IN -- The label is centered inside the image bounds.
  183.  
  184.     PLACE_LEFT -- The  label  is  placed  left  of    the  image  bounds and
  185.         centered vertically.
  186.  
  187.     PLACE_RIGHT -- The  label  is  placed  right  of the  image bounds and
  188.         centered vertically.
  189.  
  190.     PLACE_ABOVE -- The label is placed above the image bounds and centered
  191.         horizontally.
  192.  
  193.     PLACE_BELOW -- The label is placed below the image bounds and centered
  194.         horizontally.
  195.  
  196.     DEFAULT
  197.     PLACE_IN.
  198.  
  199.     APPLICABILITY
  200.     (ISG).
  201.  
  202. labelclass/LAB_Style
  203.  
  204.     NAME
  205.     LAB_Style -- ( UWORD )
  206.  
  207.     FUNCTION
  208.     Set or get  the style as defined in <graphics/text.h> which is used to
  209.     render the font. Note that this style overrides the style of  the font
  210.     passed by the LAB_TextAttr attribute.
  211.  
  212.     DEFAULT
  213.     FS_NORMAL.
  214.  
  215.     APPLICABILITY
  216.     (ISG).
  217.  
  218.     SEE ALSO
  219.     LAB_TextAttr, <graphics/text.h>
  220.  
  221. labelclass/LAB_Template
  222.  
  223.     NAME
  224.     LAB_Template -- ( Object * )
  225.  
  226.     FUNCTION
  227.     Copy all of the attributes of one labelclass object to another labelclass
  228.     object.  This allows for fast duplication of many label attributes at one
  229.     time.  You may free the template object afterwards.
  230.     
  231.     DEFAULT
  232.     NULL.
  233.  
  234.     APPLICABILITY
  235.     (ISG)
  236.  
  237.     SEE ALSO
  238.  
  239.  
  240. labelclass/LAB_TextAttr
  241.  
  242.     NAME
  243.     LAB_TextAttr -- ( struct TextAttr * )
  244.  
  245.     FUNCTION
  246.     Set  or  get  the  font that is to be used to render the label. Please
  247.     note  that the font you pass here is opened with OpenFont() so it must
  248.     be in memory already.
  249.  
  250.     DEFAULT
  251.     NULL.
  252.  
  253.     APPLICABILITY
  254.     (ISG).
  255.  
  256. labelclass/LAB_Underscore
  257.  
  258.     NAME
  259.     LAB_Underscore -- ( UBYTE )
  260.  
  261.     FUNCTION
  262.     Set or get  the  character that marks the character to be underscored.
  263.     Normally the underscore character is used to mark a key  which can be
  264.     used to control the gadget. Example:
  265.  
  266.         LAB_Underscore, '@'
  267.  
  268.         Will underscore the 'O' character in the following label:
  269.  
  270.         "@Open"
  271.  
  272.     DEFAULT
  273.     '_' (V41), 0 (<V41).
  274.  
  275.     APPLICABILITY
  276.     (ISG).
  277.  
  278. labelclass/LAB_[#?]Pen
  279.  
  280.    NAME
  281.     LAB_Pen, LAB_DriPen, LAB_SelectedPen, LAB_SelectedDriPen -- ( UWORD )
  282.     ** V39 **
  283.  
  284.    FUNCTION
  285.     To specify the colors of a label.  The    LAB_xxxPen  attributes must be
  286.     used  to  specify  the pen number of the used color. The LAB_xxxDriPen
  287.     attributes  must  be  used  to specify the DrawInfo pen number to use.
  288.     You can specify two colors: the text  color of the label in the normal
  289.     unselected state and the text color of the label in the selected
  290.     state.
  291.  
  292.     Specifying ~0 (-1) for the pens will deactivate  the  text  color  and
  293.     the class will fall back to the default coloring sceme.
  294.  
  295.     DEFAULTS
  296.     ~0.
  297.  
  298.     APPLICABILITY
  299.     (ISG).
  300.  
  301.